<?php
    /*********************************************************************************
     * Zurmo is a customer relationship management program developed by
     * Zurmo, Inc. Copyright (C) 2014 Zurmo Inc.
     *
     * Zurmo is free software; you can redistribute it and/or modify it under
     * the terms of the GNU Affero General Public License version 3 as published by the
     * Free Software Foundation with the addition of the following permission added
     * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
     * IN WHICH THE COPYRIGHT IS OWNED BY ZURMO, ZURMO DISCLAIMS THE WARRANTY
     * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
     *
     * Zurmo is distributed in the hope that it will be useful, but WITHOUT
     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
     * FOR A PARTICULAR PURPOSE.  See the GNU Affero General Public License for more
     * details.
     *
     * You should have received a copy of the GNU Affero General Public License along with
     * this program; if not, see http://www.gnu.org/licenses or write to the Free
     * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
     * 02110-1301 USA.
     *
     * You can contact Zurmo, Inc. with a mailing address at 27 North Wacker Drive
     * Suite 370 Chicago, IL 60606. or at email address contact@zurmo.com.
     *
     * The interactive user interfaces in original and modified versions
     * of this program must display Appropriate Legal Notices, as required under
     * Section 5 of the GNU Affero General Public License version 3.
     *
     * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
     * these Appropriate Legal Notices must retain the display of the Zurmo
     * logo and Zurmo copyright notice. If the display of the logo is not reasonably
     * feasible for technical reasons, the Appropriate Legal Notices must display the words
     * "Copyright Zurmo Inc. 2014. All rights reserved".
     ********************************************************************************/

    /**
     * The base View for a module's mass confirmation actions view.
     */
    abstract class MassActionRequiringConfirmationView extends MassActionView
    {
        protected $useModuleClassNameForItemLabel = true;

        public function __construct($controllerId, $moduleId, RedBeanModel $model, $activeAttributes,
                                    $selectedRecordCount, $title, $alertMessage = null,
                                    $moduleClassName = null, $useModuleClassNameForItemLabel = true)
        {
            parent::__construct($controllerId, $moduleId, $model, $activeAttributes, $selectedRecordCount,
                                $title, $alertMessage, $moduleClassName);
            $this->useModuleClassNameForItemLabel = $useModuleClassNameForItemLabel;
        }

        public static function getDefaultMetadata()
        {
            $metadata = array(
                'global' => array(
                    'toolbar' => array(
                        'elements' => array(
                            array('type' => 'CancelLink'),
                        ),
                    ),
                    'nonPlaceableAttributeNames' => array(
                        'name',
                    ),
                ),
            );
            return $metadata;
        }

        protected function renderTitleContent()
        {
            return '<h1>' . $this->title . '</h1>';
        }

        protected function renderAlertMessage()
        {
            if (!empty($this->alertMessage))
            {
                return HtmlNotifyUtil::renderAlertBoxByMessage($this->alertMessage);
            }
        }

        protected function renderPreActionElementBar($form)
        {
            return null;
        }

        protected function renderOperationHighlight()
        {
            $highlightOperation = substr($this->title, 0, strpos($this->title, ':'));
            $highlightMessage = $highlightOperation . ' is not reversable';
            return ZurmoHtml::tag('strong',
                                    array(),
                                    ZurmoHtml::tag('em',
                                                    array(),
                                                    Zurmo::t('Core', $highlightMessage)
                                                )
                                ) . ZurmoHtml::tag('br');
        }

        protected function renderItemLabel()
        {
            $type       = 'Singular';
            $className  = $this->moduleClassName;
            $method     = 'getModuleLabelByTypeAndLanguage';
            if ($this->selectedRecordCount > 1)
            {
                $type       = 'Plural';
            }
            if (!$this->useModuleClassNameForItemLabel)
            {
                $className  = $this->modelClassName;
                $method     = 'getModelLabelByTypeAndLanguage';
            }
            $label      = $className::$method($type);
            return $label;
        }

        protected function getSubmitButtonHtmlOptions()
        {
            return array('params' => array('selectedRecordCount' => $this->getSelectedRecordCount()));
        }
    }
?>